Make FDC generated SDK prompt clearer #8920
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @maneesht, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've updated the prompt message displayed to developers when generating web SDKs. The previous message was ambiguous, making it unclear that selecting additional frameworks was optional and that a default TypeScript SDK would always be generated. This change aims to improve user clarity and reduce potential confusion during the SDK setup process.
Highlights
- User Experience: Clarified the prompt message for generating web SDKs to explicitly state that framework selection is optional and that a TypeScript SDK is generated by default.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the clarity of the prompt for selecting web SDK frameworks by making it clear that the selection is optional. The change is a good improvement to the user experience. I've found one minor issue in the new prompt text where it incorrectly refers to a 'TypeScript SDK' instead of the 'vanilla JavaScript SDK' that is generated by default. I've left a suggestion to correct this.
| @@ -116,8 +116,7 @@ async function askQuestions(setup: Setup, config: Config): Promise<SDKInfo> { | |||
| if (unusedFrameworks.length > 0) { | |||
| const additionalFrameworks = await checkbox<(typeof SUPPORTED_FRAMEWORKS)[number]>({ | |||
| message: | |||
| "Which frameworks would you like to generate SDKs for? " + | |||
| "Press Space to select features, then Enter to confirm your choices.", | |||
| "Which frameworks would you like to generate SDKs for in addition to the TypeScript SDK? Press Enter to skip.\n", | |||
There was a problem hiding this comment.
The new prompt mentions a 'TypeScript SDK', but it seems a 'vanilla JavaScript SDK' is generated by default for the web platform. This is also what the pull request description mentions. To avoid confusion, could you update the prompt to refer to the 'vanilla JavaScript SDK'?
| "Which frameworks would you like to generate SDKs for in addition to the TypeScript SDK? Press Enter to skip.\n", | |
| "Which frameworks would you like to generate SDKs for in addition to the vanilla JavaScript SDK? Press Enter to skip.\n", |
github-project-automation
bot
moved this to Approved [PR]
in [Cloud] Extensions + Functions
github-project-automation
bot
moved this from Approved [PR]
to Done
in [Cloud] Extensions + Functions
When developers get started with the web SDKs, we ask what frameworks they want to support, but it isn't clear that this is optional, and the vanilla TS SDK is generated by default.
Before:
After:
